Категоризированные домены
Метод получения доменов с категориями (хешированный FQDN)
Метод API GET /api/v2/domains/categorized/hashed используется для получения доменов с хешированным FQDN. Соответствует старому endpoint'у GET /v1/collections/domains-categories/hashed.
В ответе API предоставляется массив объектов, содержащих домены с хешированным FQDN.
Пример запроса
curl --location --request GET 'https://api.data.rt-solar.ru/api/v2/domains/categorized/hashed' \
--header 'Authorization: Bearer {JWT_TOKEN}'
Параметры запроса
Запрос метода API GET /api/v2/domains/categorized/hashed содержит следующие параметры:
| Параметр | Тип данных | Обязательность | Описание | Варианты значений |
|---|---|---|---|---|
| direction_sort | string | нет | Задает направление сортировки. При ASC порядок записей в ответе отсортирован по возрастанию updated_at, при DESC - по убыванию | Может принимать значения ASC, DESC |
| updated_at | string | нет | Временная метка в формате ISO 8601 с микросекундами создания или обновления записи. Если параметр не передан, поиск выполняется по всем записям без фильтрации по времени. Если параметр указан, запрос вернёт записи, дата создания или обновления которых сравнивается с указанным значением в зависимости от направления сортировки (direction_sort) | 2024-07-22T10:30:00.123456Z |
| limit | int | нет | Ограничивает количество записей в ответе. Если параметр не передан, по умолчанию возвращается до 1000 записей. Максимальное количество записей в одном ответе - 10000. Для получения большего количества данных выполните следующий запрос, указав в параметре updated_at максимальное значение updated_at из предыдущего ответа | 100 |
Пример ответа с кодом 200
[
{
"categories": [
{
"id": 2701,
"name": "Азартные игры, онлайн-казино",
"description": "Сайты, связанные с играми на деньги, справочники, правила по таким играм, форумы, блоги об азартных играх; игровое оборудование, онлайн казино; букмекерские конторы, интернет-магазины, связанные с азартными играми",
"group_id": 2700,
"group_name": "Игры"
},
{
"id": 2702,
"name": "Игры, онлайн-игры",
"description": "Сайты, связанные с компьютерными или другими видами игр.",
"group_id": 2700,
"group_name": "Игры"
}
],
"hash_fqdn": "ac8af3bc7b1463a592f054ed4a32583a",
"last_categorized_at": "2024-07-22T10:30:00.000000Z",
"updated_at": "2024-07-22T10:30:00.123456Z"
}
]
Описание ответа
- Все данные временных меток возвращаются в формате ISO 8601 с точностью до микросекунд.
- Если список возвращаемых ответов или значение поля пустое, то в ответе данные поля будут отсутствовать.
В результате выполнения запроса GET /api/v2/domains/categorized/hashed будет возвращен массив объектов, содержащих следующие поля:
| Поле | Тип данных | Описание | ||
|---|---|---|---|---|
| categories | Список категорий домена | id | uint64 | Идентификатор категории (sub_num), например, 2702 |
| name | string | Название категории (sub_name), например, "Игры, онлайн-игры" | ||
| description | string | Описание категории, например, "Сайты, связанные с компьютерными или другими видами игр." | ||
| group_id | uint64 | Идентификатор группы категории (cat_num), например, 2700 | ||
| group_name | string | Название группы категорий (cat_name), например, "Игры" | ||
| hash_fqdn | string | Хеш-сумма SHA256 от оригинального значения FQDN | ||
| last_categorized_at | string | Дата последней категоризации домена в формате ISO 8601 | ||
| updated_at | string | Дата и время (в формате ISO 8601 с микросекундами) создания или последнего обновления записи | ||
Метод получения доменов с категориями (открытый FQDN)
Метод API GET /api/v2/domains/categorized/plain используется для получения доменов с открытым FQDN. Соответствует старому endpoint'у GET /v1/collections/domains-categories/plain.
В ответе API предоставляется массив объектов, содержащих домены с открытым FQDN.
Пример запроса
curl --location --request GET 'https://api.data.rt-solar.ru/api/v2/domains/categorized/plain' \
--header 'Authorization: Bearer {JWT_TOKEN}'
Параметры запроса
Запрос метода API GET /api/v2/domains/categorized/plain содержит следующие параметры:
| Параметр | Тип данных | Обязательность | Описание | Варианты значений |
|---|---|---|---|---|
| direction_sort | string | нет | Задает направление сортировки. При ASC порядок записей в ответе отсортирован по возрастанию updated_at, при DESC - по убыванию | Может принимать значения ASC, DESC |
| updated_at | string | нет | Временная метка в формате ISO 8601 с микросекундами создания или обновления записи. Если параметр не передан, поиск выполняется по всем записям без фильтрации по времени. Если параметр указан, запрос вернёт записи, дата создания или обновления которых сравнивается с указанным значением в зависимости от направления сортировки (direction_sort) | 2024-07-22T10:30:00.123456Z |
| limit | int | нет | Ограничивает количество записей в ответе. Если параметр не передан, по умолчанию возвращается до 1000 записей. Максимальное количество записей в одном ответе - 10000. Для получения большего количества данных выполните следующий запрос, указав в параметре updated_at максимальное значение updated_at из предыдущего ответа | 100 |
Пример ответа с кодом 200
[
{
"categories": [
{
"id": 2701,
"name": "Азартные игры, онлайн-казино",
"description": "Сайты, связанные с играми на деньги, справочники, правила по таким играм, форумы, блоги об азартных играх; игровое оборудование, онлайн казино; букмекерские конторы, интернет-магазины, связанные с азартными играми",
"group_id": 2700,
"group_name": "Игры"
}
],
"fqdn": "example.com",
"original_fqdn": "example.com",
"last_categorized_at": "2024-07-22T10:30:00.000000Z",
"updated_at": "2024-07-22T10:30:00.123456Z"
}
]
Описание ответа
- Все данные временных меток возвращаются в формате ISO 8601 с точностью до микросекунд.
- Если список возвращаемых ответов или значение поля пустое, то в ответе данные поля будут отсутствовать.
В результате выполнения запроса GET /api/v2/domains/categorized/plain будет возвращен массив объектов, содержащих следующие поля:
| Поле | Тип данных | Описание | ||
|---|---|---|---|---|
| categories | Список категорий домена | id | uint64 | Идентификатор категории (sub_num), например, 2702 |
| name | string | Название категории (sub_name), например, "Игры, онлайн-игры" | ||
| description | string | Описание категории, например, "Сайты, связанные с компьютерными или другими видами игр." | ||
| group_id | uint64 | Идентификатор группы категории (cat_num), например, 2700 | ||
| group_name | string | Название группы категорий (cat_name), например, "Игры" | ||
| fqdn | string | Оригинальное значение FQDN | ||
| original_fqdn | string | Оригинальное значение FQDN (дублирует fqdn для обратной совместимости) | ||
| last_categorized_at | string | Дата последней категоризации домена в формате ISO 8601 | ||
| updated_at | string | Дата и время (в формате ISO 8601 с микросекундами) создания или последнего обновления записи | ||
Структура ответа при ошибке
При ошибках 401, 404 и 500 структура ответа будет содержать код ошибки (status), сообщение об ошибке (message) и опционально описание (description).
Пример ответа с кодами 401, 404 и 500
{
"description": "string",
"message": "string",
"status": 401
}
При возвращении ошибки 400 в ответе перечисляются все параметры, не прошедшие валидацию:
Пример ответа с кодом 400
{
"description": "Ошибка валидации входных параметров",
"errors": {
"updated_at": "Filed value does not match required ISO 8601 format with microseconds"
},
"message": "ErrValidationError",
"status": 400
}